Scope ViewModels with StateObject + export ViewModel dependency #86
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @mlykotom, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the integration of Kotlin Multiplatform ViewModels with SwiftUI by enabling proper lifecycle management using @StateObject and cleaning up the Swift API surface. The changes allow for more idiomatic SwiftUI development patterns while consuming KMP ViewModels, ensuring that resources are correctly managed and Swift code is more readable.
Highlights
- ViewModel Lifecycle Management in SwiftUI: I've updated
IOSViewModelStoreOwnerto be anObservableObjectand added adeinitmethod that clears theviewModelStore. This enablesIOSViewModelStoreOwnerto be used with SwiftUI's@StateObjectproperty wrapper, ensuring that ViewModels are properly cleared when the associated SwiftUI view is deallocated, thus managing their lifecycle effectively. - SwiftUI Integration Simplification: The
CartViewandFruittieScreennow directly use@StateObjectforIOSViewModelStoreOwnerinstead of relying on theViewModelStoreOwnerProviderwrapper. This simplifies the view hierarchy and makes the ViewModel store owner's lifecycle explicit within the view itself. - Kotlin Multiplatform Dependency Export: The
androidx.lifecycle.viewmodeldependency is now explicitlyexported from the shared Kotlin Multiplatform module to the iOS framework. This change, along with changing the dependency type fromimplementationtoapiinbuild.gradle.kts, ensures that Swift can directly access theViewModelrelated types without theLifecycle_viewmodel_prefix, leading to cleaner Swift API usage. - Kotlin-Swift Interop Refinement: The Kotlin extension function for retrieving ViewModels has been refactored from
ViewModelStore.getViewModeltoViewModelStoreOwner.viewModel. This aligns with theIOSViewModelStoreOwnernow directly conforming toViewModelStoreOwnerand provides a more idiomatic Swift-like method signature.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request refactors the ViewModel lifecycle management on iOS by scoping ViewModels to specific screens using @StateObject instead of a shared ViewModelStoreOwner via @EnvironmentObject. This improves encapsulation and lifecycle correctness. Additionally, exporting the androidx.lifecycle.viewmodel dependency to Swift cleans up the API by removing Lifecycle_viewmodel_ prefixes. The review identifies a critical issue with error handling in IOSViewModelStoreOwner and a medium-severity issue regarding potentially obsolete code.
deinitin theIOSViewModelStoreOwnerto allow retrieving viewModel scoped to one screen with@StateObject.Lifecycle_viewmodel_prefix, we'reexportingthe dependency now